docs: fixing typos, missing links and small omissions - #241
Merged
madebydavid merged 1 commit intoAug 6, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Resolves documentation issues reported in #240 by correcting typos, fixing broken/incorrect anchors and examples, and regenerating command reference output so the published docs match the current CLI help and command metadata.
Changes:
- Fixes doc-generation escaping so command descriptions render correctly in generated markdown.
- Corrects CLI command descriptions/examples in source so generated reference pages are accurate.
- Updates multiple reference docs pages to fix typos, broken anchors, stale help output formatting, and small omissions.
Reviewed changes
Copilot reviewed 54 out of 54 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| src/commands/internal/readme.tsx | Adjusts EJS templating so generated command descriptions aren’t HTML-escaped in reference docs. |
| src/commands/game/ios/profile/import.tsx | Fixes grammar in the command description (“a Mobile…”). |
| src/commands/game/ios/app/sync.tsx | Fixes typo in command description (“Synchronizes…”). |
| src/commands/game/android/keyStore/import.tsx | Expands command description to include JKS-vs-ZIP import behavior. |
| src/commands/game/android/apiKey/import.tsx | Fixes example to include the required FILE argument. |
| src/commands/game/android/apiKey/export.tsx | Fixes example filename to reflect API key export (not keystore). |
| README.md | Corrects iOS sync capability list and adds the missing “addTester --self” step. |
| package.json | Fixes typo in topic description (“they” → “the”). |
| docs/README.md | Fixes wording/typos and aligns topic descriptions. |
| docs/login.md | Updates flag formatting to match current help output wrapping. |
| docs/help.md | Updates optional argument rendering to [COMMAND...]. |
| docs/game/status.md | Fixes “currently directory” typo. |
| docs/game/ship.md | Fixes contradictory demo-credentials description and documents implied --skipPublish. |
| docs/game/list.md | Refreshes help output ordering to match current generated output. |
| docs/game/job/status.md | Updates page heading template and refreshes help output ordering. |
| docs/game/job/list.md | Updates page heading template and refreshes help output ordering. |
| docs/game/job.md | Fixes “currently directory” typo and refreshes embedded help blocks. |
| docs/game/ios/profile/status.md | Updates page heading template. |
| docs/game/ios/profile/import.md | Updates page heading template, description grammar, and help output ordering. |
| docs/game/ios/profile/export.md | Updates page heading template and help output ordering. |
| docs/game/ios/profile/create.md | Updates page heading template and help output ordering. |
| docs/game/ios/profile.md | Fixes “currently directory” typo and refreshes embedded help blocks/description text. |
| docs/game/ios/app/sync.md | Updates page heading template, fixes escaped quotes/typo, and refreshes help output ordering. |
| docs/game/ios/app/status.md | Updates page heading template. |
| docs/game/ios/app/create.md | Updates page heading template and help output ordering. |
| docs/game/ios/app/addTester.md | Updates page heading template. |
| docs/game/ios/app.md | Fixes “currently directory” typo and updates embedded sync description text. |
| docs/game/ios.md | Fixes “currently directory” typo in topic page text. |
| docs/game/details.md | Fixes grammar and corrects androidPackageName documentation to reflect real usage. |
| docs/game/build/list.md | Updates page heading template and refreshes help output ordering. |
| docs/game/build/download.md | Updates page heading template. |
| docs/game/build.md | Refreshes embedded help output ordering. |
| docs/game/android/keyStore/import.md | Updates description and reflects optional [FILE] arg plus current help output formatting. |
| docs/game/android/keyStore/export.md | Refreshes help output ordering. |
| docs/game/android/keyStore.md | Refreshes embedded help output formatting (including optional arg rendering) and description. |
| docs/game/android/apiKey/import.md | Refreshes help output ordering and fixes example to include FILE. |
| docs/game/android/apiKey/export.md | Refreshes help output ordering and fixes example filename. |
| docs/game/android/apiKey/create.md | Refreshes help output ordering. |
| docs/game/android/apiKey/connect.md | Refreshes help output ordering. |
| docs/game/android/apiKey.md | Fixes embedded examples to match corrected source examples. |
| docs/game.md | Adds missing game android topic link. |
| docs/apple/status.md | Adds missing trailing period in description to match source. |
| docs/apple/certificate/status.md | Updates page heading template. |
| docs/apple/certificate/import.md | Updates page heading template. |
| docs/apple/certificate/export.md | Updates page heading template. |
| docs/apple/certificate/create.md | Updates page heading template. |
| docs/apple/certificate.md | Fixes typo (“read more about”). |
| docs/apple/apiKey/status.md | Updates page heading template. |
| docs/apple/apiKey/import.md | Updates page heading template. |
| docs/apple/apiKey/export.md | Updates page heading template. |
| docs/apple/apiKey/create.md | Updates page heading template. |
| docs/apple.md | Fixes broken anchors and adds missing Apple API key/certificate commands to the topic list. |
| docs/apiKey/create.md | Refreshes help output ordering. |
| docs/apiKey.md | Refreshes embedded help output ordering. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
madebydavid
deleted the
240-docs-broken-links-and-omissions-found-from-automated-review
branch
August 6, 2026 14:18
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This is to ressolve #240